::=======================================
::Streets of Rage 2 - Turtle Power
::(Summary of Patches to Original ROM
::and to the Original TMNT Edition Hack)
::By eskayelle
::August 2019
::=======================================
::
::**CONTENTS**
::
::*****INTRODUCTION*****
::*****VERSION HISTORY*****
::*****CREDITS*****
::*****BATCH FILE ASSEMBLY*****
::*****ADDITIONAL NOTES*****
::
::
::*****INTRODUCTION*****
::
::Cowabunga!  For years, I've been wanting to play a new Ninja Turtles game,
::akin to the old arcade ones, or the ones on the 16-bit consoles.
::A year or so back, I discovered a great TMNT hack of Streets of Rage 2 by Carzj.
::
::Recently, I found on RHDN a portrait editor for the game, as written by Dha Lau Hoo.
::While deep into my NBA Jam TE hacks, I remembered that there were a few changes I'd
::have made to that great TMNT Edition hack if I could... like portraits and names on the player select screen...
::maybe add a few shadows where the turtles seemed to float during gameplay...
::
::So I decided to give an update to the hack a go.
::
::And the result is this...  Reaganomics!
::
::
::The Streets of Rage 2 - Turtle Power vx.xx [U] [h].bin file is a modified Genesis ROM of Streets of Rage 2;
::it's also an addendum to Carzj's TMNT Edition hack, adding various improvements cited in this document. 
::The romhack is distributed as an IPS patch, which should be patched to an original USA Streets of Rage 2 ROM. 
::After patching the IPS file to the original Streets of Rage 2 ROM,
::the checksum must be fixed using an application such as FixCheckSum.exe on romhacking.net (RHDN).
::
::The ROM can be opened and played via several emulators, including in Windows, Linux, and Android environments.
::
::The following is a list of known Windows or Android emulators within which this ROM works;
::note that it also works with Raspberry Pi/RetroArch. 
::
::Windows--
::1) Fusion v3.64
::2) Gens v11c r57shell mod
::3) RetroArch build date Feb 3 2019
::
::Android--
::1) MD.emu v1.5.37
::
::
::*****VERSION HISTORY*****
::This is a batch file serving two purposes--
::1) To compile all the .ips files to be associated with the
::Streets of Rage 2 Genesis ROM and create the Turtle Power ROM.
::2) To operate as a readme file, documenting the hack revisions and 
::corresponding changes to the original ROM.
::
::AUGUST 2019:
::Applied Carzj's TMNT Edition hack patch.
::Used Dha Lau Hoo's SOR2Portraits.txt tutorial to create player select portraits.
::Modified via hex editor the story in attract mode.
::Modified via hex editor the start screen text.
::Modified via hex editor the following (source: gamehacking.org)...
::::Changed $FDE0 to #$6600
::::Changed $F8EE to #$6700 (activate level select in options)
::::Changed $F9BC to #$6604 (activate 9 lives in options)
::::Changed $F974 to #$6700
::::Changed $F99C to #$6700 (activate very easy and mania in options)
::::Changed $7844 to #$6016
::::Changed $787A to #$6016 (display number of KOs above score when paused)
::::::Fun Fact: Pressing A on The Best Ten Players Screen will display K.O.s in the original game.
::Note: It appears the options level items may already be in the ROM.
::Note also that the TMNT Edition hack appears to allow the same characters to be used in a 2P game.
::It's a bug whose effect cannot be readily generated.
::Fixed names for Garcia, Garuda, and Mosquito via hex editor.
::Using RHDN forum thread info by SCD, modifed via hex editor $1E70F (now #$00 versus #$A1);
::Mr. X has his cigar restored once again.
::Modified via hex editor high score table to recognize modders and assets providers.
::Modified via hex editor credits to recognize modders and assets providers.
::Modified via hex editor the post-credits with the special message on HARDEST setting.
::Portrait edits ("sepia" style, based on original palette).
::::Note that the palettes for the flashing portraits appear to be located at $7540 and $7560.
::Portrait edits (color and blank for blink effect).
::With Dha Lau Hoo's guidance, located the offsets for the name tiles (player select screen);
::revised the bytes via hex editor to point to tiles that will assemble the TMNT names.
::Modified via hex editor address $7CC9 to set the Round 3 Pirate Ship BGM to #$09 (Little Money Avenue).
::Via Pancake 2, dumped sprite sheets for the TMNT Edition hack and added shadows to the standing and walking sprites.
::Imported those sprites back into the rom.
::Fixed glitch in Mike's attack (30 - frames 2 and 3) that were present in the original TMNT Ediiton hack.
::Fixed missing color in new Mike standing animation.
::Fixed Raph shock animation glitch from original TMNT Edition hack.
::Added shadows to Raph's run animation.
::Modified via hex editor address $F9B6 (now #$0062) and $F9BC (now #$6604) to allow 99 lives option.
::Using the air combo guide (English).txt y Dha Lau Hoo and the Streets of Rage 2 Character Physics.txt guide by Metal64,
::set up physics to allow for limited air/juggle combos.
::Via Pancake 2, revised Mike's throw animation.
::Increased forward walk speed to accommodate for more air combos.
::
::
::*****CREDITS*****
::Big thanks to the following folks for their previous work on SoR 2 and in turn the available assets and documentation.
::1) Carzj for the original TMNT Edition hack.
::2) SCD for the restoration hack.
::3) Dha Lau Hoo the portraits tutorial and guidance on editing name titles at the player select screen.
::4) Metal64 for the character physics guide.
::5) Wake for help with formatting the color schemes for the new portraits.
::6) J-Vizzle for playtesting.
::
::Special thanks to Reaper Man and RadioShadow for guidance on hacking the title screen.
::
::
::*****BATCH FILE ASSEMBLY*****
::
copy "Streets of Rage 2.gen" a.bin
::flips "SoR 2 Tmnt.ips" a.bin
flips "Streets of Rage 2 - Turtles and Shadows (Walk, Hit).ips" a.bin
flips "Streets of Rage 2 - TMNT Portraits, Palettes.ips" a.bin
flips "Streets of Rage 2 - Fix Mikey Attack.ips" a.bin
flips "Streets of Rage 2 - Fix Mikey Standing Frame.ips" a.bin
flips "Streets of Rage 2 - Fix Raph Shock.ips" a.bin
flips "Streets of Rage 2 - Raph Run.ips" a.bin
flips "Streets of Rage 2 - Revised Story.ips" a.bin
flips "Streets of Rage 2 - Press Start.ips" a.bin
flips "Streets of Rage 2 - DBLZ.ips" a.bin
::flips "Streets of Rage 2 (TMNT Hack) - Turtles Shadows (Walk, Hit).ips" a.bin
flips "Streets of Rage 2 - KO.ips" a.bin
flips "Streets of Rage 2 - Garcia,Garuda,Mosquito.ips" a.bin
flips "Streets of Rage 2 - Cigar Restored.ips" a.bin
flips "Streets of Rage 2 - Hi Scores.ips" a.bin
flips "Streets of Rage 2 - Credits.ips" a.bin
flips "Streets of Rage 2 - Post Credits.ips" a.bin
flips "Streets of Rage 2 - Names.ips" a.bin
flips "Streets of Rage 2 - Stage 3 Pirate.ips" a.bin
flips "Streets of Rage 2 - New 99 Lives Option.ips" a.bin
flips "Streets of Rage 2 - Air Combos, Less Gravity, Walk Jump Physics.ips" a.bin
flips "Streets of Rage 2 (TMNT Hack) - Mikey Throw.ips" a.bin
flips "Streets of Rage 2 - Fwd Jump Speed.ips" a.bin
::flips "Streets of Rage 2 (TMNT Hack) - Sepia Portraits.ips" a.bin
::flips "Streets of Rage 2 (TMNT Hack) - Color Portraits.ips" a.bin
ren a.bin "Streets of Rage 2 - Turtle Power v1.25 [U] [h].bin"
@pause
::
::
::*****ADDITIONAL NOTES*****
::
::FYI - The following Game Genie or PAR codes will not work in this game:
::::Infinite continues (AL7T-AA62, or #$6002 at addres $BB98)
::::99 lives on option screen
::::Various Infinite Energy / Health codes

